; Improve docstring of cl-check-type
authorStefan Kangas <stefankangas@gmail.com>
Sun, 2 Mar 2025 03:11:55 +0000 (04:11 +0100)
committerStefan Kangas <stefankangas@gmail.com>
Sun, 2 Mar 2025 03:11:55 +0000 (04:11 +0100)
* lisp/emacs-lisp/cl-macs.el (cl-check-type): Improve docstring.

lisp/emacs-lisp/cl-macs.el

index 555b4f018ad8d2efdc3e3fed805ed4dc4e7da7fe..99c105c7559eb4dc4e8cac8b1f98559ccd0d1f07 100644 (file)
@@ -3548,7 +3548,10 @@ Of course, we really can't know that for sure, so it's just a heuristic."
 ;;;###autoload
 (defmacro cl-check-type (form type &optional string)
   "Verify that FORM is of type TYPE; signal an error if not.
-STRING is an optional description of the desired type."
+STRING is an optional description of the desired type.
+
+Hint: To check the type of an object, use `cl-type-of'.
+To define new types, see `cl-deftype'."
   (declare (debug (place cl-type-spec &optional stringp)))
   (and (or (not (macroexp-compiling-p))
           (< cl--optimize-speed 3) (= cl--optimize-safety 3))